User

interface User
Content copied to clipboard

A user holds the user's metadata and tokens for accessing App Services and Device Sync functionality.

The user is used to configure synchronized realms with SyncConfiguration.Builder.

See also

Types

State
Link copied to clipboard
enum State : Enum<User.State>
Content copied to clipboard
A user's potential states.

Functions

delete
Link copied to clipboard
abstract suspend fun delete()
Content copied to clipboard
Permanently deletes this user from your Atlas App Services app.
equals
Link copied to clipboard
abstract operator override fun equals(other: Any?): Boolean
Content copied to clipboard
Two Users are considered equal if they have the same user identity and are associated with the same app.
linkCredentials
Link copied to clipboard
abstract suspend fun linkCredentials(credentials: Credentials): User
Content copied to clipboard
Links the current user with a new user identity represented by the given credentials.
logOut
Link copied to clipboard
abstract suspend fun logOut()
Content copied to clipboard
Log the user out of the Realm App.
remove
Link copied to clipboard
abstract suspend fun remove(): User
Content copied to clipboard
Removes the user and any Realms the user has from the device.

Properties

accessToken
Link copied to clipboard
abstract val accessToken: String
Content copied to clipboard
Returns the current access token for the user.
apiKeyAuth
Link copied to clipboard
abstract val apiKeyAuth: ApiKeyAuth
Content copied to clipboard
Gives access to the ApiKeyAuth interface so that users can manage their API keys.
app
Link copied to clipboard
abstract val app: App
Content copied to clipboard
The App this user is associated with.
deviceId
Link copied to clipboard
abstract val deviceId: String
Content copied to clipboard
Returns a unique identifier for the device the user logged in to.
id
Link copied to clipboard
abstract val id: String
Content copied to clipboard
The server id of the user.
identities
Link copied to clipboard
abstract val identities: List<UserIdentity>
Content copied to clipboard
Returns a list of the user's identities as defined by the authentication providers enabled for this user.
identity
Link copied to clipboard
abstract val identity: String
Content copied to clipboard
The server id of the user.
loggedIn
Link copied to clipboard
abstract val loggedIn: Boolean
Content copied to clipboard
Returns whether or not this user is still logged into the App Services Application.
provider
Link copied to clipboard
abstract val provider: AuthenticationProvider
Content copied to clipboard
Returns the provider type used to log the user in.
refreshToken
Link copied to clipboard
abstract val refreshToken: String
Content copied to clipboard
Returns the current refresh token for the user.
state
Link copied to clipboard
abstract val state: User.State
Content copied to clipboard
The State this user is in.